Deactivates a control and any latent embedded controls.

OSErr DeactivateControl (
    ControlRef inControl
);

inControl

A handle to the control to deactivate. If you pass a window’s root control, DeactivateControl deactivates all controls in that window.

function result

A result code.

DISCUSSION

The DeactivateControl function should be called instead of HiliteControl to deactivate a specified control and its latent embedded controls.

An embedded control is considered latent when it is deactivated or hidden due to its embedder control being deactivated or hidden. If you activate a latent embedded control whose embedder is deactivated, the embedded control becomes latent until the embedder is activated. However, if you deactivate a latent embedded control, it will not be activated when its embedder is activated.

If a control definition function supports activate events, it will receive a kControlMsgActivate message before redrawing itself in its inactive state.

VERSION NOTES

Available with Appearance Manager 1.0 and later.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.

© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)